User Guide - OSS

User Guide - OSS

Overview

What is Conversant Object Storage Service (OSS)?

Object Storage Service (OSS) is a scalable, secure, high-performance solution compatible with the Amazon S3 API. It is designed to store unstructured data such as application assets, media content, backups, and archives.

Data in OSS is stored as objects within buckets. Each object consists of a file, metadata, and a unique key as its identifier. Users must create a bucket before uploading objects. OSS supports S3-compatible SDKs and APIs, enabling seamless integration with existing systems and tools.

Conversant OSS integrates with Conversant CDN, providing faster data access through edge caching and optimised routing to enhance content delivery performance across web, mobile, and other client platforms.

Getting Started by Scenarios

• Data Storage

  Applications such as mobile apps, websites, and HTML5 pages often require efficient and scalable storage solutions.

  Conversant OSS supports seamless integration with various application types by providing SDKs in multiple programming languages, enabling flexible and secure object storage for data upload and access.

  Steps:

  1. Go to Buckets and click Create Bucket. Enter a bucket name (e.g., static-web-example), select the ACL permission level, and click Create Bucket.

  2. Click Credentials, go to the credentials page, and click Create Credential. Select the permission level and save the Secret Key for future access to OSS.

  3. Configure CORS (Cross-Origin Resource Sharing) rules for the bucket. Configure the CORS for the bucket through AWS SDK PutBucketCors API.

  4. Configure the server to provide an API for generating pre-signed URLs, allowing users to upload and download files within a configured time window.

  5. Configure the web front end to send an HTML form request to the server, obtain the pre-signed URL, and use it to upload files to OSS.

  6. Use the pre-signed URL to access files (e.g., images) stored in OSS.

• Data Archiving

  Organisations often need to store large volumes of data for long-term retention, such as system backups, historical records, or compliance-related information.

  Conversant OSS provides a reliable and scalable solution for backing up and archiving critical data. Access control ensures secure data access.

  Steps:

  1. Go to Credentials and click Create Credential. Select the access level and save the Secret Key to access OSS.

  2. Download and install CloudBerry Explorer, a desktop tool for managing OSS resources.

  3. Open CloudBerry Explorer, select S3 Compatible and configure the connection using your OSS access credentials. Click Test Connection to verify.

  4. In the bucket list, click Create Bucket, enter a bucket name, and click Confirm.

  5. Upload archived files by dragging them from the local system into the OSS bucket.

  6. Download archived files by selecting the objects from OSS and dragging them to your local system folders.

• Website Hosting

  Website hosting enables individuals or organisations to store website content on servers to facilitate website access. The website hosting service provider provides server, storage and related management tools to ensure the stable and secure operation of the websites.

  Conversant OSS supports static website hosting by allowing users to store website files in buckets and bind them to the customer's domains (e.g., example.com). This provides a scalable, reliable, easy-to-manage solution for delivering static websites directly through OSS.

  Steps: (use carousel)

  1. Go to Buckets and click Create Bucket. Enter a bucket name (e.g., static-web-example), select the ACL permission, and click Create Bucket.

     [Create Bucket screenshot would be displayed here]

  2. Go to Credentials and click Create Credential. Select the access level and save the Secret Key.

  3. Use the SDK or console to add a Bucket Policy, granting public read access to the bucket.

     {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Effect": "Allow",
                "Principal": "*",
                "Action": "s3:GetObject",
                "Resource": "arn:aws:s3:::Bucket-Name/*"
            }
        ]
     }
     

  4. Click the newly created bucket (e.g., static-web-example), click Upload File, and click Add Folder to upload your static website resources.

     [Upload Files screenshot would be displayed here]

     [Add Folder screenshot would be displayed here]

  5. Configure Nginx to proxy your customised domain to the OSS bucket service endpoint.

     [Configure Nginx screenshot would be displayed here]

  6. Verify whether the website is accessible through the configured customer's domain.

     [Verify Website screenshot would be displayed here]

FINAL DDL MAY 20

Reference: What is Amazon S3? - Amazon Simple Storage Service